@sentry/browser

What is @sentry/browser?

The @sentry/browser package is a JavaScript SDK for Sentry, which is an error tracking service that helps developers monitor and fix crashes in real time. The SDK hooks into the global error handling mechanisms of the browser and captures unhandled exceptions and other errors, providing rich context and insights into the underlying issues.

What are @sentry/browser's main functionalities?

Error Tracking

This feature automatically captures JavaScript exceptions and sends them to Sentry for analysis and tracking. The code initializes Sentry with a DSN (Data Source Name) and sets up a global error handler to capture exceptions.

Sentry.init({ dsn: 'YOUR_DSN' });

window.onerror = function (errorMsg, url, lineNumber, column, errorObj) {
  Sentry.captureException(errorObj);
  return false;
}

Manual Error Reporting

This allows developers to manually report exceptions or errors to Sentry. The code block demonstrates how to catch an error in a try-catch block and manually send it to Sentry using the captureException method.

Sentry.init({ dsn: 'YOUR_DSN' });

try {
  // Code that might fail
} catch (error) {
  Sentry.captureException(error);
}

Performance Monitoring

This feature enables performance monitoring by capturing transactions and spans. The code initializes Sentry with a sample rate for transactions and demonstrates how to start and finish a transaction, which can be used to measure the performance of operations.

Sentry.init({ dsn: 'YOUR_DSN', tracesSampleRate: 1.0 });

const transaction = Sentry.startTransaction({ name: 'test transaction' });
// ... some code ...
transaction.finish();

Breadcrumbs

Breadcrumbs are a trail of events that happened prior to an issue. This feature allows you to record breadcrumbs manually. The code shows how to add a breadcrumb for an authentication event.

Sentry.init({ dsn: 'YOUR_DSN' });

Sentry.addBreadcrumb({
  category: 'auth',
  message: 'User authenticated',
  level: Sentry.Severity.Info
});

User Feedback

This feature allows you to collect user feedback when an error occurs. The code initializes Sentry and then shows a dialog to the user to collect feedback for a specific event.

Sentry.init({ dsn: 'YOUR_DSN' });

Sentry.showReportDialog({ eventId: 'event_id' });

Other packages similar to @sentry/browser

bugsnag-js

Bugsnag provides similar error tracking and monitoring capabilities as Sentry. It offers real-time error reporting and can be used to monitor application stability. Bugsnag also provides features for error diagnostics and supports multiple platforms.

raygun4js

Raygun is another error monitoring service that offers crash reporting with detailed diagnostics. It supports real-time error tracking and performance monitoring, and it can be used to identify and diagnose software errors and performance issues.

rollbar-browser

Rollbar offers real-time error tracking and is similar to Sentry in its capabilities. It includes features like telemetry, person tracking, and version tracking. Rollbar provides a comprehensive dashboard for monitoring and analyzing errors.

README

Official Sentry SDK for Browsers

Links

• Official SDK Docs
• TypeDoc

Usage

To use this SDK, call Sentry.init(options) as early as possible after loading the page. This will initialize the SDK and hook into the environment. Note that you can turn off almost all side effects using the respective options.

import * as Sentry from '@sentry/browser';

Sentry.init({
  dsn: '__DSN__',
  // ...
});

To set context information or send manual events, use the exported functions of @sentry/browser. Note that these functions will not perform any action before you have called Sentry.init():

import * as Sentry from '@sentry/browser';

// Set user information, as well as tags and further extras
Sentry.setExtra('battery', 0.7);
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
  message: 'My Breadcrumb',
  // ...
});

// Capture exceptions, messages or manual events
Sentry.captureMessage('Hello, world!');
Sentry.captureException(new Error('Good bye'));
Sentry.captureEvent({
  message: 'Manual',
  stacktrace: [
    // ...
  ],
});

Changelog

8.41.0

Important Changes

• meta(nuxt): Require minimum Nuxt v3.7.0 (#14473)

  We formalized that the Nuxt SDK is at minimum compatible with Nuxt version 3.7.0 and above. Additionally, the SDK requires the implicit nitropack dependency to satisfy version ^2.6.1 and ofetch to satisfy ^1.3.3. It is recommended to check your lock-files and manually upgrade these dependencies if they don't match the version ranges.

Deprecations

We are deprecating a few APIs which will be removed in the next major.

The following deprecations will potentially affect you:

• feat(core): Update & deprecate undefined option handling (#14450)

  In the next major version we will change how passing undefined to tracesSampleRate / tracesSampler / enableTracing will behave.

  Currently, doing the following:

  Sentry.init({
    tracesSampleRate: undefined,
  });
  

  Will result in tracing being enabled (although no spans will be generated) because the tracesSampleRate key is present in the options object. In the next major version, this behavior will be changed so that passing undefined (or rather having a tracesSampleRate key) will result in tracing being disabled, the same as not passing the option at all. If you are currently relying on undefined being passed, and and thus have tracing enabled, it is recommended to update your config to set e.g. tracesSampleRate: 0 instead, which will also enable tracing in v9.

  The same applies to tracesSampler and enableTracing.

• feat(core): Log warnings when returning null in beforeSendSpan (#14433)

  Currently, the beforeSendSpan option in Sentry.init() allows you to drop individual spans from a trace by returning null from the hook. Since this API lends itself to creating "gaps" inside traces, we decided to change how this API will work in the next major version.

  With the next major version the beforeSendSpan API can only be used to mutate spans, but no longer to drop them. With this release the SDK will warn you if you are using this API to drop spans. Instead, it is recommended to configure instrumentation (i.e. integrations) directly to control what spans are created.

  Additionally, with the next major version, root spans will also be passed to beforeSendSpan.

• feat(utils): Deprecate @sentry/utils (#14431)

  With the next major version the @sentry/utils package will be merged into the @sentry/core package. It is therefore no longer recommended to use the @sentry/utils package.

• feat(vue): Deprecate configuring Vue tracing options anywhere else other than through the vueIntegration's tracingOptions option (#14385)

  Currently it is possible to configure tracing options in various places in the Sentry Vue SDK:

  • In Sentry.init()
  • Inside tracingOptions in Sentry.init()
  • In the vueIntegration() options
  • Inside tracingOptions in the vueIntegration() options

  Because this is a bit messy and confusing to document, the only recommended way to configure tracing options going forward is through the tracingOptions in the vueIntegration(). The other means of configuration will be removed in the next major version of the SDK.

• feat: Deprecate registerEsmLoaderHooks.include and registerEsmLoaderHooks.exclude (#14486)

  Currently it is possible to define registerEsmLoaderHooks.include and registerEsmLoaderHooks.exclude options in Sentry.init() to only apply ESM loader hooks to a subset of modules. This API served as an escape hatch in case certain modules are incompatible with ESM loader hooks.

  Since this API was introduced, a way was found to only wrap modules that there exists instrumentation for (meaning a vetted list). To only wrap modules that have instrumentation, it is recommended to instead set registerEsmLoaderHooks.onlyIncludeInstrumentedModules to true.

  Note that onlyIncludeInstrumentedModules: true will become the default behavior in the next major version and the registerEsmLoaderHooks will no longer accept fine-grained options.

The following deprecations will most likely not affect you unless you are building an SDK yourself:

• feat(core): Deprecate arrayify (#14405)
• feat(core): Deprecate flatten (#14454)
• feat(core): Deprecate urlEncode (#14406)
• feat(core): Deprecate validSeverityLevels (#14407)
• feat(core/utils): Deprecate getNumberOfUrlSegments (#14458)
• feat(utils): Deprecate memoBuilder, BAGGAGE_HEADER_NAME, and makeFifoCache (#14434)
• feat(utils/core): Deprecate addRequestDataToEvent and extractRequestData (#14430)

Other Changes

• feat: Streamline sentry-trace, baggage and DSC handling (#14364)
• feat(core): Further optimize debug ID parsing (#14365)
• feat(node): Add openTelemetryInstrumentations option (#14484)
• feat(nuxt): Add filter for not found source maps (devtools) (#14437)
• feat(nuxt): Only delete public source maps (#14438)
• fix(nextjs): Don't report NEXT_REDIRECT from browser (#14440)
• perf(opentelemetry): Bucket spans for cleanup (#14154)

Work in this release was contributed by @NEKOYASAN and @fmorett. Thank you for your contributions!